<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>PreparedQueryDefinition | @vertx/consul-client</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@vertx/consul-client</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="preparedquerydefinition.html">PreparedQueryDefinition</a>
				</li>
			</ul>
			<h1>Class PreparedQueryDefinition</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Defines a prepared query.</p>
					</div>
					<dl class="tsd-comment-tags">
						<dt>author</dt>
						<dd><p><a href="mailto:ruslan.sennov@gmail.com">Ruslan Sennov</a></p>
						</dd>
					</dl>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">PreparedQueryDefinition</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Constructors</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="preparedquerydefinition.html#constructor" class="tsd-kind-icon">constructor</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Methods</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getdcs" class="tsd-kind-icon">get<wbr>Dcs</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getdnsttl" class="tsd-kind-icon">get<wbr>Dns<wbr>Ttl</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getid" class="tsd-kind-icon">get<wbr>Id</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getmeta" class="tsd-kind-icon">get<wbr>Meta</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getnearestn" class="tsd-kind-icon">get<wbr>NearestN</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getpassing" class="tsd-kind-icon">get<wbr>Passing</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getservice" class="tsd-kind-icon">get<wbr>Service</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#getsession" class="tsd-kind-icon">get<wbr>Session</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#gettags" class="tsd-kind-icon">get<wbr>Tags</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#gettemplateregexp" class="tsd-kind-icon">get<wbr>Template<wbr>Regexp</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#gettemplatetype" class="tsd-kind-icon">get<wbr>Template<wbr>Type</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#gettoken" class="tsd-kind-icon">get<wbr>Token</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setdcs" class="tsd-kind-icon">set<wbr>Dcs</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setdnsttl" class="tsd-kind-icon">set<wbr>Dns<wbr>Ttl</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setid" class="tsd-kind-icon">set<wbr>Id</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setmeta" class="tsd-kind-icon">set<wbr>Meta</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setname" class="tsd-kind-icon">set<wbr>Name</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setnearestn" class="tsd-kind-icon">set<wbr>NearestN</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setpassing" class="tsd-kind-icon">set<wbr>Passing</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setservice" class="tsd-kind-icon">set<wbr>Service</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#setsession" class="tsd-kind-icon">set<wbr>Session</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#settags" class="tsd-kind-icon">set<wbr>Tags</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#settemplateregexp" class="tsd-kind-icon">set<wbr>Template<wbr>Regexp</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#settemplatetype" class="tsd-kind-icon">set<wbr>Template<wbr>Type</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="preparedquerydefinition.html#settoken" class="tsd-kind-icon">set<wbr>Token</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Constructors</h2>
				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
					<a name="constructor" class="tsd-anchor"></a>
					<h3>constructor</h3>
					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">new <wbr>Prepared<wbr>Query<wbr>Definition<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
						<li class="tsd-signature tsd-kind-icon">new <wbr>Prepared<wbr>Query<wbr>Definition<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2705</li>
								</ul>
							</aside>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
						</li>
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2707</li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>obj: <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
						</li>
					</ul>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Methods</h2>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getdcs" class="tsd-anchor"></a>
					<h3>get<wbr>Dcs</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Dcs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2719</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes
										in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined
										with NearestN, then the NearestN queries will be performed first, followed by the list given by Datacenters.
										A given datacenter will only be queried one time during a failover, even if it is selected by both NearestN
									and is listed in Datacenters.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getdnsttl" class="tsd-anchor"></a>
					<h3>get<wbr>Dns<wbr>Ttl</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Dns<wbr>Ttl<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2740</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the TTL duration when query results are served over DNS. If this is specified,
									it will take precedence over any Consul agent-specific configuration.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getid" class="tsd-anchor"></a>
					<h3>get<wbr>Id</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2757</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set ID of the query, always generated by Consul</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getmeta" class="tsd-anchor"></a>
					<h3>get<wbr>Meta</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Meta<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2774</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set a list of user-defined key/value pairs that will be used for filtering the query results to nodes
									with the given metadata values present.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getname" class="tsd-anchor"></a>
					<h3>get<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2791</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set an optional friendly name that can be used to execute a query instead of using its ID</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getnearestn" class="tsd-anchor"></a>
					<h3>get<wbr>NearestN</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>NearestN<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2809</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network
										round trip time using Network Coordinates from the WAN gossip pool. The median round trip time from the server
									handling the query to the servers in the remote datacenter is used to determine the priority.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getpassing" class="tsd-anchor"></a>
					<h3>get<wbr>Passing</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Passing<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2829</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Specifies the behavior of the query&#39;s health check filtering. If this is set to false, the results will include
										nodes with checks in the passing as well as the warning states. If this is set to true,
									only nodes with checks in the passing state will be returned.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getservice" class="tsd-anchor"></a>
					<h3>get<wbr>Service</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Service<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2847</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the name of the service to query</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getsession" class="tsd-anchor"></a>
					<h3>get<wbr>Session</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Session<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2864</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the ID of an existing session. This provides a way to automatically remove a prepared query when
									the given session is invalidated. If not given the prepared query must be manually removed when no longer needed.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="gettags" class="tsd-anchor"></a>
					<h3>get<wbr>Tags</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Tags<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2882</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set a list of service tags to filter the query results. For a service to pass the tag filter
									it must have all of the required tags, and none of the excluded tags (prefixed with <code>!</code>).</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="gettemplateregexp" class="tsd-anchor"></a>
					<h3>get<wbr>Template<wbr>Regexp</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Template<wbr>Regexp<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2900</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set regular expression which is used to extract fields from the entire name, once this template is selected.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>see</dt>
									<dd><p><a href="https://www.consul.io/api/query.html#prepared-query-templates">Prepared Query Templates</a> endpoint</p>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="gettemplatetype" class="tsd-anchor"></a>
					<h3>get<wbr>Template<wbr>Type</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Template<wbr>Type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2919</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The template type, which must be {@code name_prefix_match}. This means that the template will apply to
									any query lookup with a name whose prefix matches the Name field of the template.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>see</dt>
									<dd><p><a href="https://www.consul.io/api/query.html#prepared-query-templates">Prepared Query Templates</a> endpoint</p>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="gettoken" class="tsd-anchor"></a>
					<h3>get<wbr>Token</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Token<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2938</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the ACL token to use each time the query is executed. This allows queries to be executed by clients
									with lesser or even no ACL Token, so this should be used with care.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setdcs" class="tsd-anchor"></a>
					<h3>set<wbr>Dcs</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Dcs<span class="tsd-signature-symbol">(</span>dcs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2731</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Specifies a fixed list of remote datacenters to forward the query to if there are no healthy nodes
										in the local datacenter. Datacenters are queried in the order given in the list. If this option is combined
										with NearestN, then the NearestN queries will be performed first, followed by the list given by Datacenters.
										A given datacenter will only be queried one time during a failover, even if it is selected by both NearestN
									and is listed in Datacenters.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>dcs: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the list of remote datacenters</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setdnsttl" class="tsd-anchor"></a>
					<h3>set<wbr>Dns<wbr>Ttl</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Dns<wbr>Ttl<span class="tsd-signature-symbol">(</span>dnsTtl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2749</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the TTL duration when query results are served over DNS. If this is specified,
									it will take precedence over any Consul agent-specific configuration.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>dnsTtl: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the TTL duration</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setid" class="tsd-anchor"></a>
					<h3>set<wbr>Id</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Id<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2765</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set ID of the query, always generated by Consul</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>id: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>ID of the query</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setmeta" class="tsd-anchor"></a>
					<h3>set<wbr>Meta</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Meta<span class="tsd-signature-symbol">(</span>meta<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2783</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set a list of user-defined key/value pairs that will be used for filtering the query results to nodes
									with the given metadata values present.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>meta: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>list of key/value pairs</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setname" class="tsd-anchor"></a>
					<h3>set<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2799</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set an optional friendly name that can be used to execute a query instead of using its ID</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>name: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>name of the query</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setnearestn" class="tsd-anchor"></a>
					<h3>set<wbr>NearestN</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>NearestN<span class="tsd-signature-symbol">(</span>nearestN<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2819</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Specifies that the query will be forwarded to up to NearestN other datacenters based on their estimated network
										round trip time using Network Coordinates from the WAN gossip pool. The median round trip time from the server
									handling the query to the servers in the remote datacenter is used to determine the priority.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>nearestN: <span class="tsd-signature-type">number</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>number of nearest datacenters to query</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setpassing" class="tsd-anchor"></a>
					<h3>set<wbr>Passing</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Passing<span class="tsd-signature-symbol">(</span>passing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2839</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Specifies the behavior of the query&#39;s health check filtering. If this is set to false, the results will include
										nodes with checks in the passing as well as the warning states. If this is set to true,
									only nodes with checks in the passing state will be returned.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>passing: <span class="tsd-signature-type">boolean</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the passing flag</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setservice" class="tsd-anchor"></a>
					<h3>set<wbr>Service</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Service<span class="tsd-signature-symbol">(</span>service<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2855</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the name of the service to query</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>service: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>service name</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setsession" class="tsd-anchor"></a>
					<h3>set<wbr>Session</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Session<span class="tsd-signature-symbol">(</span>session<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2873</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the ID of an existing session. This provides a way to automatically remove a prepared query when
									the given session is invalidated. If not given the prepared query must be manually removed when no longer needed.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>session: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>id of session</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="settags" class="tsd-anchor"></a>
					<h3>set<wbr>Tags</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Tags<span class="tsd-signature-symbol">(</span>tags<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2891</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set a list of service tags to filter the query results. For a service to pass the tag filter
									it must have all of the required tags, and none of the excluded tags (prefixed with <code>!</code>).</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>tags: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>list of service tags</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="settemplateregexp" class="tsd-anchor"></a>
					<h3>set<wbr>Template<wbr>Regexp</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Template<wbr>Regexp<span class="tsd-signature-symbol">(</span>templateRegexp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2909</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set regular expression which is used to extract fields from the entire name, once this template is selected.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>see</dt>
									<dd><p><a href="https://www.consul.io/api/query.html#prepared-query-templates">Prepared Query Templates</a> endpoint</p>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>templateRegexp: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>a regular expression</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="settemplatetype" class="tsd-anchor"></a>
					<h3>set<wbr>Template<wbr>Type</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Template<wbr>Type<span class="tsd-signature-symbol">(</span>templateType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2929</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The template type, which must be {@code name_prefix_match}. This means that the template will apply to
									any query lookup with a name whose prefix matches the Name field of the template.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>see</dt>
									<dd><p><a href="https://www.consul.io/api/query.html#prepared-query-templates">Prepared Query Templates</a> endpoint</p>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>templateType: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the query type</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="settoken" class="tsd-anchor"></a>
					<h3>set<wbr>Token</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Token<span class="tsd-signature-symbol">(</span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:2947</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Set the ACL token to use each time the query is executed. This allows queries to be executed by clients
									with lesser or even no ACL Token, so this should be used with care.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>token: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the ACL token</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="preparedquerydefinition.html" class="tsd-signature-type">PreparedQueryDefinition</a></h4>
							<p>reference to this, for fluency</p>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class">
						<a href="acltoken.html" class="tsd-kind-icon">Acl<wbr>Token</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="blockingqueryoptions.html" class="tsd-kind-icon">Blocking<wbr>Query<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="check.html" class="tsd-kind-icon">Check</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="checklist.html" class="tsd-kind-icon">Check<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="checkoptions.html" class="tsd-kind-icon">Check<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="checkqueryoptions.html" class="tsd-kind-icon">Check<wbr>Query<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="consulclient.html" class="tsd-kind-icon">Consul<wbr>Client</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="consulclientoptions.html" class="tsd-kind-icon">Consul<wbr>Client<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="coordinate.html" class="tsd-kind-icon">Coordinate</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="coordinatelist.html" class="tsd-kind-icon">Coordinate<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="dccoordinates.html" class="tsd-kind-icon">Dc<wbr>Coordinates</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="event.html" class="tsd-kind-icon">Event</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="eventlist.html" class="tsd-kind-icon">Event<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="eventlistoptions.html" class="tsd-kind-icon">Event<wbr>List<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="eventoptions.html" class="tsd-kind-icon">Event<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="keyvalue.html" class="tsd-kind-icon">Key<wbr>Value</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="keyvaluelist.html" class="tsd-kind-icon">Key<wbr>Value<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="keyvalueoptions.html" class="tsd-kind-icon">Key<wbr>Value<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="maintenanceoptions.html" class="tsd-kind-icon">Maintenance<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="node.html" class="tsd-kind-icon">Node</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="nodelist.html" class="tsd-kind-icon">Node<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="nodequeryoptions.html" class="tsd-kind-icon">Node<wbr>Query<wbr>Options</a>
					</li>
				</ul>
				<ul class="current">
					<li class="current tsd-kind-class">
						<a href="preparedquerydefinition.html" class="tsd-kind-icon">Prepared<wbr>Query<wbr>Definition</a>
						<ul>
							<li class=" tsd-kind-constructor tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#constructor" class="tsd-kind-icon">constructor</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getdcs" class="tsd-kind-icon">get<wbr>Dcs</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getdnsttl" class="tsd-kind-icon">get<wbr>Dns<wbr>Ttl</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getid" class="tsd-kind-icon">get<wbr>Id</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getmeta" class="tsd-kind-icon">get<wbr>Meta</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getname" class="tsd-kind-icon">get<wbr>Name</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getnearestn" class="tsd-kind-icon">get<wbr>NearestN</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getpassing" class="tsd-kind-icon">get<wbr>Passing</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getservice" class="tsd-kind-icon">get<wbr>Service</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#getsession" class="tsd-kind-icon">get<wbr>Session</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#gettags" class="tsd-kind-icon">get<wbr>Tags</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#gettemplateregexp" class="tsd-kind-icon">get<wbr>Template<wbr>Regexp</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#gettemplatetype" class="tsd-kind-icon">get<wbr>Template<wbr>Type</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#gettoken" class="tsd-kind-icon">get<wbr>Token</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setdcs" class="tsd-kind-icon">set<wbr>Dcs</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setdnsttl" class="tsd-kind-icon">set<wbr>Dns<wbr>Ttl</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setid" class="tsd-kind-icon">set<wbr>Id</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setmeta" class="tsd-kind-icon">set<wbr>Meta</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setname" class="tsd-kind-icon">set<wbr>Name</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setnearestn" class="tsd-kind-icon">set<wbr>NearestN</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setpassing" class="tsd-kind-icon">set<wbr>Passing</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setservice" class="tsd-kind-icon">set<wbr>Service</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#setsession" class="tsd-kind-icon">set<wbr>Session</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#settags" class="tsd-kind-icon">set<wbr>Tags</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#settemplateregexp" class="tsd-kind-icon">set<wbr>Template<wbr>Regexp</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#settemplatetype" class="tsd-kind-icon">set<wbr>Template<wbr>Type</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="preparedquerydefinition.html#settoken" class="tsd-kind-icon">set<wbr>Token</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
					<li class=" tsd-kind-class">
						<a href="preparedqueryexecuteoptions.html" class="tsd-kind-icon">Prepared<wbr>Query<wbr>Execute<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="preparedqueryexecuteresponse.html" class="tsd-kind-icon">Prepared<wbr>Query<wbr>Execute<wbr>Response</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="service.html" class="tsd-kind-icon">Service</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="serviceentry.html" class="tsd-kind-icon">Service<wbr>Entry</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="serviceentrylist.html" class="tsd-kind-icon">Service<wbr>Entry<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="servicelist.html" class="tsd-kind-icon">Service<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="serviceoptions.html" class="tsd-kind-icon">Service<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="servicequeryoptions.html" class="tsd-kind-icon">Service<wbr>Query<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="session.html" class="tsd-kind-icon">Session</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="sessionlist.html" class="tsd-kind-icon">Session<wbr>List</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="sessionoptions.html" class="tsd-kind-icon">Session<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="txnerror.html" class="tsd-kind-icon">Txn<wbr>Error</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="txnkvoperation.html" class="tsd-kind-icon">TxnKVOperation</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="txnrequest.html" class="tsd-kind-icon">Txn<wbr>Request</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="txnresponse.html" class="tsd-kind-icon">Txn<wbr>Response</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="watch.html" class="tsd-kind-icon">Watch</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="watchresult.html" class="tsd-kind-icon">Watch<wbr>Result</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>